<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.playlists.html">playlists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Deletes a playlist.</p>
<p class="toc_element">
  <code><a href="#insert">insert(part=None, body)</a></code></p>
<p class="firstline">Creates a playlist.</p>
<p class="toc_element">
  <code><a href="#list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, id=None)</a></code></p>
<p class="firstline">Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#update">update(part=None, body)</a></code></p>
<p class="firstline">Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(id)</code>
  <pre>Deletes a playlist.

Args:
  id: string, The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(part=None, body)</code>
  <pre>Creates a playlist.

Args:
  part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

The part names that you can include in the parameter value are snippet and status. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
      # 
      # YouTube also uses playlists to identify special collections of videos for a channel, such as:
      # - uploaded videos
      # - favorite videos
      # - positively rated (liked) videos
      # - watch history
      # - watch later  To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
      # 
      # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
    "status": { # The status details of a playlist describes whether the playlist is private. # The status object contains status information for the playlist.
      "privacyStatus": "A String", # The playlist's privacy status.
    },
    "kind": "youtube#playlist", # The type of the API resource. For video resources, the value will be youtube#playlist.
    "contentDetails": { # Details about the content of a playlist, such as the video count. # The contentDetails object contains information like video count.
      "itemCount": 42, # The number of videos in the playlist.
    },
    "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
      "title": "A String", # The playlist's title.
      "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
      "description": "A String", # The playlist's description.
      "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
        "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
          "url": "A String", # The thumbnail image's URL.
          "width": 42, # (Optional) Width of the thumbnail image.
          "height": 42, # (Optional) Height of the thumbnail image.
        },
      },
    },
    "player": { # Player to be used for a playlist playback. # The player object contains information that you would use to play the playlist in an embedded player.
      "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
    },
    "etag": "A String", # The ETag for the playlist resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
  }


Returns:
  An object of the form:

    { # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
        #
        # YouTube also uses playlists to identify special collections of videos for a channel, such as:
        # - uploaded videos
        # - favorite videos
        # - positively rated (liked) videos
        # - watch history
        # - watch later  To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
        #
        # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
      "status": { # The status details of a playlist describes whether the playlist is private. # The status object contains status information for the playlist.
        "privacyStatus": "A String", # The playlist's privacy status.
      },
      "kind": "youtube#playlist", # The type of the API resource. For video resources, the value will be youtube#playlist.
      "contentDetails": { # Details about the content of a playlist, such as the video count. # The contentDetails object contains information like video count.
        "itemCount": 42, # The number of videos in the playlist.
      },
      "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
        "title": "A String", # The playlist's title.
        "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
        "description": "A String", # The playlist's description.
        "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        "thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
          "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
            "url": "A String", # The thumbnail image's URL.
            "width": 42, # (Optional) Width of the thumbnail image.
            "height": 42, # (Optional) Height of the thumbnail image.
          },
        },
      },
      "player": { # Player to be used for a playlist playback. # The player object contains information that you would use to play the playlist in an embedded player.
        "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
      },
      "etag": "A String", # The ETag for the playlist resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, id=None)</code>
  <pre>Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.

Args:
  part: string, The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and status.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. (required)
  pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
  channelId: string, This value indicates that the API should only return the specified channel's playlists.
  mine: boolean, Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.
  maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
  id: string, The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID.

Returns:
  An object of the form:

    { # A paginated list of playlists returned as the response to a youtube.playlists.list call.
    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
    "kind": "youtube#playlistListResponse", # The type of the API response. For this operation, the value will be youtube#playlistListResponse.
    "items": [ # A list of playlists that match the request criteria.
      { # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
            #
            # YouTube also uses playlists to identify special collections of videos for a channel, such as:
            # - uploaded videos
            # - favorite videos
            # - positively rated (liked) videos
            # - watch history
            # - watch later  To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
            #
            # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
          "status": { # The status details of a playlist describes whether the playlist is private. # The status object contains status information for the playlist.
            "privacyStatus": "A String", # The playlist's privacy status.
          },
          "kind": "youtube#playlist", # The type of the API resource. For video resources, the value will be youtube#playlist.
          "contentDetails": { # Details about the content of a playlist, such as the video count. # The contentDetails object contains information like video count.
            "itemCount": 42, # The number of videos in the playlist.
          },
          "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
            "title": "A String", # The playlist's title.
            "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
            "description": "A String", # The playlist's description.
            "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
              "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
                "url": "A String", # The thumbnail image's URL.
                "width": 42, # (Optional) Width of the thumbnail image.
                "height": 42, # (Optional) Height of the thumbnail image.
              },
            },
          },
          "player": { # Player to be used for a playlist playback. # The player object contains information that you would use to play the playlist in an embedded player.
            "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
          },
          "etag": "A String", # The ETag for the playlist resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
        },
    ],
    "etag": "A String", # The ETag of the response.
    "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
      "totalResults": 42, # The total number of results in the result set.
      "resultsPerPage": 42, # The number of results included in the API response.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="update">update(part=None, body)</code>
  <pre>Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.

Args:
  part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

The part names that you can include in the parameter value are snippet and status.

Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
      # 
      # YouTube also uses playlists to identify special collections of videos for a channel, such as:
      # - uploaded videos
      # - favorite videos
      # - positively rated (liked) videos
      # - watch history
      # - watch later  To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
      # 
      # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
    "status": { # The status details of a playlist describes whether the playlist is private. # The status object contains status information for the playlist.
      "privacyStatus": "A String", # The playlist's privacy status.
    },
    "kind": "youtube#playlist", # The type of the API resource. For video resources, the value will be youtube#playlist.
    "contentDetails": { # Details about the content of a playlist, such as the video count. # The contentDetails object contains information like video count.
      "itemCount": 42, # The number of videos in the playlist.
    },
    "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
      "title": "A String", # The playlist's title.
      "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
      "description": "A String", # The playlist's description.
      "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
        "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
          "url": "A String", # The thumbnail image's URL.
          "width": 42, # (Optional) Width of the thumbnail image.
          "height": 42, # (Optional) Height of the thumbnail image.
        },
      },
    },
    "player": { # Player to be used for a playlist playback. # The player object contains information that you would use to play the playlist in an embedded player.
      "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
    },
    "etag": "A String", # The ETag for the playlist resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
  }


Returns:
  An object of the form:

    { # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
        #
        # YouTube also uses playlists to identify special collections of videos for a channel, such as:
        # - uploaded videos
        # - favorite videos
        # - positively rated (liked) videos
        # - watch history
        # - watch later  To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
        #
        # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
      "status": { # The status details of a playlist describes whether the playlist is private. # The status object contains status information for the playlist.
        "privacyStatus": "A String", # The playlist's privacy status.
      },
      "kind": "youtube#playlist", # The type of the API resource. For video resources, the value will be youtube#playlist.
      "contentDetails": { # Details about the content of a playlist, such as the video count. # The contentDetails object contains information like video count.
        "itemCount": 42, # The number of videos in the playlist.
      },
      "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
        "title": "A String", # The playlist's title.
        "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
        "description": "A String", # The playlist's description.
        "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        "thumbnails": { # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
          "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name. This value is used as the key in the snippet.thumbnails map.
            "url": "A String", # The thumbnail image's URL.
            "width": 42, # (Optional) Width of the thumbnail image.
            "height": 42, # (Optional) Height of the thumbnail image.
          },
        },
      },
      "player": { # Player to be used for a playlist playback. # The player object contains information that you would use to play the playlist in an embedded player.
        "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
      },
      "etag": "A String", # The ETag for the playlist resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
    }</pre>
</div>

</body></html>